home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 476-500 / disk_497 / mouseblanker / mouseblanker.doc < prev    next >
Text File  |  1992-05-06  |  9KB  |  224 lines
  1.  
  2.                              MouseBlanker
  3.  
  4.                              (Commodity)
  5.  
  6.                                   by
  7.  
  8.                             Stefan Sticht
  9.  
  10.          This program (binary), sourcecode, documentation is
  11.  
  12.                             PUBLIC DOMAIN.
  13.  
  14.                      You may do anything with it!
  15.  
  16.  
  17. Purpose of this commodity:
  18. --------------------------
  19. MouseBlanker  is  a  commodity, which blanks the mouse pointer after a
  20. specified  timeout  period  since you moved the mouse the last time or
  21. immediatly  when  you  press  any key on the keyboard.  The pointer is
  22. restored  next  time  you move the mouse.  This is done to prevent the
  23. mouse  pointer  hiding  any  information while you are typing text for
  24. example, as it does most time.
  25.  
  26. Requirements:
  27. -------------
  28. This  commodity  requires  at least Kickstart 37.* and Workbench 37.*.
  29. Please  check  this  out  using Version in the Shell or About from the
  30. Workbench's   Workbench   menu.    You   also   need   to   have   the
  31. commodities.library  in your libs:  directory.  Please check this out:
  32. type "dir libs:" in the shell.
  33.  
  34. How to start a commodity:
  35. -------------------------
  36. First  there  are  two  basically different ways to start a commodity:
  37. via Workbench or via Shell.
  38.  
  39.     Starting  it  via Workbench is extrem simple:  just doubleclick on
  40. its  icon  and  the  commodity gets started.  Perhaps you might change
  41. some  parameters of the commodity.  You do this with tool types.  Tool
  42. types can be changed by clicking at the commodities icon and selecting
  43. Information from the Workbench's Icon menu.  In the window which opens
  44. you  see a listview gadget in which all tool types are listed.  Please
  45. refer  to  your  Workbench  documentation  on  how to change this tool
  46. types.  Which parameters you can change for this specific commodity is
  47. described below.
  48.     Please  note  that  another  double  click on the commodity's icon
  49. forces  the  commodity  to  open  its window, if it's already running.
  50. Running  two  copies of MouseBlanker at the same time isn't useful and
  51. therefore possible.  Any changes in tool types aren't told the running
  52. copy  of  the Mouseblanker; you have to kill the running one and start
  53. it again.
  54.     To  start  a commodity via shell you type in its name.  If you get
  55. an  "Unknown  command  ???"  error  message,  you  have misspelled the
  56. commodity's  name  or the commodity isn't in your current directory or
  57. in the current search path.  The easiest way is to change your current
  58. directory  to the location of the commodity using the CD command.  You
  59. can  change  parameters  of  a commodity by command line options.  The
  60. available options are listed with ?  as the first parameter:
  61.  
  62.                             Mouseblanker ?
  63.  
  64. gives you a list of the command line options.  The explanation of each
  65. option is below.  Starting the commodity once more while it is already
  66. running  forces  the  commodity  to  open its window.  No command line
  67. option is parsed or updated if you start the commodity a second time.
  68.  
  69.     If  you  want  the  commodity to be started at every boot-up, it's
  70. best to add this line to your User-Startup file:
  71.  
  72.                      <path>Mouseblanker <options>
  73.  
  74. Don't  forget  to  replace  <path>  by  the  path to the commodities's
  75. location  and <options> by the options you want to change. For example
  76. add this line if your commodity is located in the Tools drawer of your
  77. boot disk and if you want the pointer to be blanked after 5 seconds:
  78.  
  79.                      Tools/MouseBlanker SECONDS=5
  80.  
  81.     Another way to start the commodity at every boot-up is to drag its
  82. icon  in  the  WBStartup drawer of your boot disk.  Then the commodity
  83. gets  started  as if you had double clicked on its icon.  But you have
  84. to  add the tool type DONOTWAIT to the icon.
  85.  
  86. Using Exchange:
  87. ---------------
  88. Exchange is the commodities controller program. With Exchange you can
  89. control all commodities: you can kill, disable, enable, show and hide
  90. commodities.
  91.     Start  the  Exchange  program,  which  usually is in the Utilities
  92. drawer  of your boot disk, by double clicking its icon.  Now you see a
  93. list  of  the available commodities.  Select the commodity you want to
  94. control.   The  commodities title, description and status is shown now
  95. below the listview gadget.
  96.     You  can  kill  the  commodity  using  the  Kill gadget...  If the
  97. commodity  has  a  window  to  open,  in which you usually change some
  98. parameters,  you  can  open  this window using Show.  Hide closes this
  99. window.
  100.  
  101.                         Changeable parameters:
  102.                         ----------------------
  103.  
  104. CX_Priority:
  105. ------------
  106. You  can  specify the priority of the Commodity within the commodities
  107. queue using the tool type or commandline option CX_PRIORITY=<n>, where
  108. <n> is the decimal value for the priority.  Default priority is 0.
  109.  
  110. Seconds:
  111. --------
  112. With  the tool type or command line option SECONDS you can specify the
  113. initial  value  of  the  timeout period, after which the mouse pointer
  114. will be blanked.  Use SECONDS=<seconds>, where <seconds> is a positive
  115. decimal  value.  Setting SECONDS=0 disables this feature.  The default
  116. timeout is 3 seconds.
  117.     After  having  started  the  commodity, you can change the timeout
  118. value in a small pop up window, too.  To open this window you need the
  119. Exchange  program  or  a  hotkey  installed.   Open Exchange's window,
  120. select  the  MouseBlanker,  then  select  Show.  Now the window of the
  121. MouseBlanker  has  opened.   There  you  can change the timeout value.
  122. Using  the  Hide  gadget  the  window  closes  and the commodity keeps
  123. running.  The Quit gadget removes the commodity.
  124.  
  125. KEYPRESS:
  126. ---------
  127. With  the  tool  type  or  command line option KEYPRESS=YES|NO you can
  128. specify  wether  the  mousepointer  shall  be  blanked  immediatly  on
  129. pressing  any  key  of the keyboard.  YES|NO means, you can either use
  130. YES  or  NO.   Default  is  YES.   This  option  can be changed in the
  131. MousBlanker's window, too.
  132.  
  133. CX_POPKEY:
  134. ----------
  135. You  can  specify  a  hotkey,  with which you can open the commodity's
  136. window, using the tool type or command line option CX_POPKEY=<hotkey>.
  137. <hotkey>  is  any input description string as explained below.  If you
  138. omit  this  option,  no  hotkey  will be installed and memory usage is
  139. reduced.  Default is no hotkey installed.
  140.  
  141. Examples:
  142.  
  143.     CX_POPKEY=f1                (F1 opens the window)
  144.     "CX_POPKEY=lshift f1"       (left shift and F1)
  145.     "CX_POPKEY=alt m"           (either alt and M)
  146.  
  147. CX_POPUP:
  148. ---------
  149. With  the  tool  type  or  command line option CX_POPUP=YES|NO you can
  150. specify  wether  the commodity's window shall open at startup.  YES|NO
  151. means that you have to use either YES or NO, nothing else.  Default is
  152. NO.
  153.  
  154.                       Input description strings
  155.                       -------------------------
  156.  
  157. With  input  description  strings  you  can  specify  almost any input
  158. action,  for  example  the action lshift f1, which means that pressing
  159. the  left  shift  and  the  f1  key  together  is the action.  In this
  160. commodity  you  can specify the action to open the commodity's window,
  161. as described above.
  162.  
  163. Input description strings have the following template:
  164.  
  165.       [class] (([-]qual)|syn)* [[-]upstroke] [highmap|ANSIcode]
  166.  
  167. (* means zero or more occurances of the of the expression in brackets)
  168.  
  169. class   is one of the following strings:
  170.         rawkey, rawmouse, event, pointerpos, timer, newprefs,
  171.         diskremoved, diskinserted.
  172.         If not specified, the class is taken to be "rawkey".
  173.  
  174. qual    is one of the strings:
  175.         lshift, rshift, capslock, control, lalt, ralt, lcommand,
  176.         rcommand, numericpad, repeat, midbutton, rbutton, leftbutton,
  177.         relativemouse
  178.         A preceding '-' means that the value of the corresponding
  179.         qualifier is to be considered irrelevant.
  180.  
  181. syn     (synonym) is one of the strings: shift, caps, alt
  182.         shift means "left or right shift"
  183.         caps means "shift or capslock"
  184.         alt means "either alt key"
  185.  
  186. upstroke (literally "upstroke")
  187.         if this token is absent, only downstrokes are considered
  188.         for rawmouse (mousebuttons) and rawkey events.  If it is
  189.         present alone, only upstrokes count.  If it preceded by
  190.         '-' it means that both up and down strokes are included.
  191.  
  192. highmap one of the strings:
  193.         comma, space, backspace, tab, enter, return, esc, del, up, down,
  194.         right, left, help, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10,
  195.         0, 1, 2, 3, 4, 5, 6, 7, 8, 9, (, ), /, *, -, +
  196.  
  197. ansicode a single character token is interpreted as a character code,
  198.         which is looked up in the system default keymap.
  199.  
  200. Some full examples:
  201. -------------------
  202.  
  203.     MouseBlanker Seconds=10
  204.     MouseBlanker Seconds=5 "cx_popkey=ctrl 1" cx_popup=yes
  205.     MouseBlanker Seconds=15 "cx_popkey=help" keypress=no
  206.  
  207. Send bug-reports, enhancement-requests, questions, gifts(!) to:
  208. ---------------------------------------------------------------
  209. Stefan Sticht
  210. Bibereckerweg 40a
  211. D-8390 Passau 18
  212. FRG
  213.  
  214. or (better) EMail to:
  215. Internet: cbmvax.commodore.com!cbmehq!cbmger!edith!sticht@rutgers.EDU
  216.       or: IWSTICHT@ibm.rz.uni-passau.de
  217. Fido-Net: Stefan Sticht (2:242/16:4)
  218.  
  219.  
  220.  
  221. Please include the version number of the commodity in every bug report
  222. You  get  the  version  number  using  the  Version  command:
  223.                      Version [<path>]<commodity>
  224.